home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 4 / United Public Domain Gold 4.iso / scope / sc150.dms / sc150.adf / Convert / Convert.Doc < prev    next >
Text File  |  1990-09-12  |  7KB  |  233 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                               Convert It!
  9.                               ===========
  10.  
  11.  
  12.   Convert whatever you wish (ASCII) to anything you like (ASCII) ;-).
  13.  
  14.   Explanation:
  15.  
  16.     ConvertIt! will convert any ASCII file of any size to the results
  17.     you wish with the help of a conversion data file created prior running
  18.     the program.
  19.  
  20.  
  21.  
  22.   The conversion data file has the following format...
  23.  
  24.     4:testTEST
  25.     3:andet encore
  26.     5:AtariAmiga
  27.     1:\009\032\032
  28.  
  29.  
  30.   Where [4] means --> The first 4 chars in the line after the colon [:]
  31.                                             represents the word I wish to convert
  32.                                             to the rest of the chars in the line.
  33.                       Meaning --> convert test (first 4 chars) to
  34.                       TEST (uppercase).
  35.  
  36.   In the second line, [and], the first 3 letters, would be converted to
  37.     [et encore].
  38.  
  39.   In the third line, [Atari] would be converted to [Amiga]. :-)
  40.  
  41.   And the fourth line, TAB (represented by the \009 which IS EQUAL to one char)
  42.   would be converted to TWO SPACES chars (represented by the \032).
  43.     (See below about the backslash '\' char.)
  44.  
  45.  
  46.  
  47.   Notes of importances: 
  48.     1>. The conversions are case sensitive. So in line 3, Atari will be
  49.         converted, but not atari or ATARI or aTaRi.
  50.  
  51.     2>. Each lines have a maximum of 80 chars. Meaning the #, including
  52.         the colon[:] and both the word to be converted and the conversion
  53.         must fit into 80 chars. (nothing stops you to complete a conversion
  54.         by making the (suite) on another line).
  55.  
  56.     3>. The Default conversion data file is named 'Default.cnv' and should
  57.         be located in the S: directory.  You can always use another one by
  58.         using the [-c] option following by the name of the file you wish to
  59.         use.
  60.  
  61.         ex: conv -cMyConvFile [filename to convert]
  62.         would convert [filename to convert] using MyConvFile as the data
  63.         file.  (note that the name is NOT case sensitive).
  64.  
  65.     4>. The maximum number of conversions you can put in the data file 
  66.         is now set to  80.  
  67.  
  68.     5>. The backslash '\' is considered as an invisible special char by
  69.         the program.  If the program encounters it, it will then check if
  70.         the following char is a '\',  or a 3 numbered decimal digit, or
  71.         just another char.  If it is a 3 numbered digit, then it will
  72.         converted to a special char. (e.g. Tab, carriage return, etc).
  73.         If the next char is another '\' then it will be considered as
  74.         a backslash and not as a special char.
  75.         If it is just another char, then the '\' will be ignored.
  76.  
  77.  
  78.     6>. If you wish to convert the following string '\009' but want the
  79.         program to take it as '\009' and not as a TAB, then create the line
  80.         as follow...
  81.  
  82.           4:\\009\\x09
  83.  
  84.         This will convert '\009' as the string '\x09'. Notice that [4]
  85.         was used for the # of chars.  This is because the '\' is a special
  86.         char and is considered 'invisible'.
  87.  
  88.  
  89.   So, that means that you can convert (almost) anything, including control
  90.   chars into words or controls chars!! 
  91.  
  92.  
  93.  
  94.  
  95.   Here are the options the program offers:
  96.  
  97.         [-?]    Help Mode. --> Prints (on screen) a help message.
  98.  
  99.     [-q]    Quiet Mode. --> no dots for every conversion occuring.
  100.  
  101.     [-u]    Upper Case Mode. --> Will convert everything to UpperCase.
  102.                                  (After the conversions of course :-))
  103.  
  104.     [-l]    Lower Case Mode. --> Will convert everything to LowerCase.
  105.                                  (Ditto)
  106.  
  107.     [-n]    No Conversion. --> Will not process the conversions. But will
  108.                                process UPPER, LOWER, and BreakLine Mode.
  109.  
  110.     [-b]    Break Line Mode. --> Will try to convert lines over 80 chars in
  111.                                 lenght to below or equals to 80 chars.
  112.                                 (Note that SPACES are required to be able
  113.                                  to break the line.) (will change in next ver)
  114.  
  115.     [-cCONVFILE]   Use Another Conversion Data File.
  116.                    If this option is not used, the 'S:Default.cnv' file will
  117.                    be used.
  118.  
  119.     These options can be in any order you wish.  The only exception to the
  120.     rule, is that the files you wish to convert have to be the lasts
  121.     arguments!!  Notice that you can uses as many files as you wish to
  122.     convert at the same time. 
  123.  
  124.  
  125.     The output or result of the conversion will be name [filename.cvo].
  126.  
  127.  
  128.     Examples:
  129.  
  130.     conv
  131.     or
  132.     conv -?
  133.  
  134.     ... will print a help message.
  135.  
  136.  
  137.  
  138.     conv test1 test2.txt test3 test4.cmp
  139.  
  140.     ... will convert test1, test2.txt, test3, and test4.cmp using the
  141.         's:default.cnv' file for conversion data and will output
  142.         test1.cvo, test2.txt.cvo, text3.cvo and test4.cmp.cvo!
  143.  
  144.  
  145.  
  146.     conv -cconv.test -u test1 test2.txt
  147.  
  148.     ... will convert test1 and test2.txt using 'conv.test' file for 
  149.         conversion data and will output, all in UPPER, test1.cvo and
  150.         test2.txt.cvo
  151.  
  152.  
  153.  
  154.     conv -cconv.test -n -b -q -l test1
  155.  
  156.     ... will transform test1 to LOWER cases, break the lines to 80 chars where
  157.         possible, turn on quiet mode, but WILL NOT convert the file [-n].
  158.         And the output will be test1.cvo.
  159.  
  160.  
  161.  
  162.   NOTES concerning the files to be converted...
  163.  
  164.     1>. The file can be as big as you wish (limit -> half or HD space :))
  165.  
  166.     2>. The maximum lenght of individual lines can go up to 32000 bytes!!!
  167.         (May change in future versions).
  168.  
  169.     3>. I've tried binary files and it worked on some of them.  But right
  170.         now the program doesn't support this option.
  171.  
  172.         4>. The output file keeps the same name but with .cvo added to it.
  173.  
  174.  
  175.  
  176.   NOTES concerning the program...
  177.  
  178.     1>. When run, the program takes exactly 120 kb bytes of memory,
  179.         however big the file to convert is to convert.
  180.         (Sorry about that, will see to it).
  181.  
  182.     2>. So far, when runned, the program exits cleanly without any loss of
  183.         memory.  It's also been tested for out of mem errors.
  184.  
  185.     3>. Just don't know if it will work properly on OS 2.0. Should though,
  186.         because the program mainly uses 'C' libraries, not Amiga libs.
  187.  
  188.     4>. Special chars supported (1.0) are \0,\007,\008,\009,\010,\011,\012,
  189.         \013,\027,\032.  All the ASCII codes after \032 through \128.
  190.  
  191.         5>. The dots, when running, indicates the number of conversion occuring
  192.                 within the file.  (Quiet Mode cancels the dots).
  193.  
  194.  
  195.  
  196.   NOTES about the user...
  197.  
  198.     1>. Should you find any bugs (there's almost always one creeping 
  199.         somewhere), if you wish, you can report them to me at (See below)
  200.  
  201.     2>. Should you find the program interresting, please report it to me.
  202.         ;-) (See below)
  203.  
  204.     3>. Should you not like this program, or would like to see some options
  205.         added to it, you can reach ....... (ditto). :)
  206.  
  207.     4>. Thank you for using this program.  Hope you like it.
  208.  
  209.         5>. You can distribute this program provided that the present
  210.                 Doc file be included with it's original content.
  211.  
  212.  
  213.                       Copyrights 1990 Rejean Gravel.  
  214.  
  215.  
  216.   NOTES about me....
  217.   
  218.    Can be reached at: Compuserve, Rejean Gravel, 73617,604.
  219.  
  220.  
  221. Enjoy.
  222.  
  223. Rej.
  224.  
  225. 11/Sept/1990
  226.  
  227. /* End Of File */
  228.  
  229.  
  230.  
  231.  
  232.  
  233.